/*
 * Copyright (c) 2008-2016 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.haulmont.cuba.gui.components.filter;

import com.haulmont.cuba.gui.components.Filter;

import javax.annotation.Nullable;

/**
 * Interface implementations is used to convert filter xml to conditions tree and vice versa
 *
 */
public interface FilterParser {
    String NAME = "cuba_FilterParser";

    ConditionsTree getConditions(Filter filter, String xml);

    /**
     * Converts filter conditions tree to filter xml
     * @param conditions conditions tree
     * @param valueProperty Describes what parameter value will be serialized to xml: current value or default one
     * @return filter xml
     */
    @Nullable
    String getXml(ConditionsTree conditions, Param.ValueProperty valueProperty);
}
